package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.MemoEmpAddDTO;
import org.jsola.hr.dto.MemoEmpUpdateDTO;
import org.jsola.hr.query.MemoEmpQuery;
import org.jsola.hr.vo.MemoEmpListVO;
import org.jsola.hr.vo.MemoEmpVO;

import java.util.List;

/**
 * 备忘录相关员工
 *
 * @author zhr
 */
@Api(tags = "hr-备忘录相关员工")
public interface IMemoEmpControllerAPI {

    /**
     * 新增备忘录相关员工
     * @param memoEmpAddDTO 备忘录相关员工新增实体
     * @return 备忘录相关员工展示对象
     */
    @ApiOperation(value = "新增备忘录相关员工")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoEmpAddDTO", dataType = "MemoEmpAddDTO", value = "新增备忘录相关员工", paramType = "body")
    })
    Result<MemoEmpVO> save(MemoEmpAddDTO memoEmpAddDTO);


    /**
     * 修改备忘录相关员工
     * @param memoEmpUpdateDTO 备忘录相关员工
     * @return 更新数量
     */
    @ApiOperation(value = "修改备忘录相关员工")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoEmpUpdateDTO", dataType = "MemoEmpUpdateDTO", value = "修改备忘录相关员工", paramType = "body")
    })
    Result<Integer> update(MemoEmpUpdateDTO memoEmpUpdateDTO);




    /**
     * 删除单个备忘录相关员工，彻底删除
     * @param memoEmpId 备忘录相关员工id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个备忘录相关员工，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoEmpId", dataType = "String", value = "备忘录相关员工id", paramType = "path")
    })
    Result<Integer> delete(String memoEmpId);


    /**
     * 批量删除备忘录相关员工，彻底删除
     * @param memoEmpIds 备忘录相关员工id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除备忘录相关员工，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoEmpIds", dataType = "String[]", value = "备忘录相关员工id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] memoEmpIds);


    /**
     * 根据备忘录相关员工id查询备忘录相关员工详情
     * @param memoEmpId 备忘录相关员工id
     * @return 备忘录相关员工详情
     */
    @ApiOperation(value="根据备忘录相关员工id查询备忘录相关员工详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoEmpId", dataType = "String", value = "备忘录相关员工id", paramType = "path")
    })
    Result<MemoEmpVO> findById(String memoEmpId);


    /**
     * 查询备忘录相关员工
     * @param memoEmpQuery 备忘录相关员工查询参数
     * @return page
     */
    @ApiOperation(value="查询备忘录相关员工")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoEmpQuery", dataType = "MemoEmpQuery", value = "备忘录相关员工查询参数", paramType = "query")
    })
    Result<List<MemoEmpListVO>> listAll(MemoEmpQuery memoEmpQuery);


     /**
     * 分页查询备忘录相关员工
     * @param memoEmpQuery 备忘录相关员工查询参数
     * @return page
     */
    @ApiOperation(value="分页查询备忘录相关员工")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "memoEmpQuery", dataType = "MemoEmpQuery", value = "备忘录相关员工查询参数", paramType = "query")
    })
    Result<Page<MemoEmpListVO>> page(MemoEmpQuery memoEmpQuery);


}

